home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 1 / Cream of the Crop 1.iso / UTILITY / FSRCH21.ARJ / FSRCH.DOC next >
Text File  |  1992-07-06  |  8KB  |  165 lines
  1.  
  2.  
  3.  
  4.                FSRCH - FILE SEARCH UTILITY
  5.                       version 2.1
  6.  
  7.              Copyright (c) 1988-1992, Stan Leeson
  8.                     All Rights Reserved
  9.  
  10.  
  11.  
  12. FSRCH is a text file search utility that allows you to search through a
  13. collection of files for lines that contain a target string or for lines
  14. that relate to a pair of target strings in a prescribed manner.  It 
  15. provides you with a simple but powerful user interface to aid you in
  16. locating text items quickly and easily.
  17.  
  18. Programmers often work with programs made up of a collection of source
  19. language files.  When the applications are large and complex, it is often
  20. easy to misplace the definition of a variable, the source of a function,
  21. calls to a given subroutine, etc.  FSRCH can help you locate these items 
  22. quickly.  Other users may want to find a given text string in a set of 
  23. ASCII documentation files, word processor files, or even executable
  24. files.  Again, FSRCH can easily do that for you.
  25.  
  26. FSRC is called from the command line with no parameters.  The form of the
  27. call is simply:  FSRCH
  28. The list of matches is written to "FSRCH.OUT" in the current
  29. default directory.
  30.  
  31. Once FSRCH begins execution, it presents a form with 7 fields on the screen.
  32. This form is used to control the type of search that is performed.  Context
  33. sensitive help can be obtained by highlighting the field of interest with
  34. the cursor arrow keys on the numeric keypad and pressing the F1 key.  You
  35. may fill in the fields in order pressing ENTER or TAB to move from one field
  36. to the next, or you may use the cursor arrow keys to move the highlighting 
  37. and fill in the fields in any order that you like.  Once you have completely
  38. specified the search that you would like performed, you indicate that the
  39. parameters are complete by holding down the Control key (Ctrl) and pressing
  40. he enter key.  The individual fields are desrcribed below:
  41.  
  42. FIELD 1 - FILE PATTERN
  43.      The file pattern is used to indicate which files are to be
  44.      searched.  It may contain a drive specification, a directory 
  45.      specification, and a file naming pattern with wild card
  46.      characters.  A typical pattern would be in the form:
  47.        \"*.C\" to indicate all files with a .C extension.  A
  48.      full pattern could be \"B:\\DIREC\\MY*.XY*\" to indicate
  49.      all files in directory \\DIREC on drive B: with a name
  50.      that begins with MY and an extension that begins with
  51.      XY are to be searched.
  52.  
  53. FIELD 2 - OBJECT 1
  54.      The object strings are those items that are to be searched
  55.      for.  The first object string is required and the second is
  56.      optional.  If the second string is empty, the relationship
  57.      is ignored, and FSRCH simply searches for occurrences of the
  58.      first string.  If both strings are specified, FSRCH finds text
  59.      lines with the proper relationship of the two strings."};
  60.  
  61. FIELD 3 - RELATION
  62.      This field tells how the two object strings are
  63.      related in text lines that are reported.  Choices:
  64.       AND  - Both object strings must appear
  65.       OR   - Either object string must appear
  66.       NOT  - The first string must appear and NOT the second
  67.       XOR  - Either string may appear but not both
  68.       SOLO - Only the first is searched for
  69.      The relationships may be abbreviated to just the initial character.
  70.      If the relationship is omitted, it is assumed to be SOLO if the
  71.      second object string is NULL and AND if it is not.
  72.  
  73. FIELD 4 - OBJECT 2
  74.      The object strings are those items that are to be searched
  75.      for.  The first object string is required and the second is
  76.      optional.  If the second string is empty, the relationship
  77.      is ignored, and FSRCH simply searches for occurrences of the
  78.      first string.  If both strings are specified, FSRCH finds text
  79.      lines with the proper relationship of the two strings."};
  80.  
  81.  
  82. FIELD 5 - CASE SENSITIVE
  83.      This field should be filled with a Y or N to indicate whether
  84.      or not the search should be case sensitive.  If this field is left
  85.      blank or set to N, upper case and lower case letters are considered
  86.      to be equivalent.
  87.  
  88. FIELD 6 - PAUSE
  89.      This field is set to Y or N to indicate whether FSRCH should
  90.      pause after each match that is found.  If pause is selected, FSRCH 
  91.      stops after each matching line and waits for you to press a key
  92.      before continuing.
  93.  
  94. FIELD 7 - SEVEN BITS
  95.     This field is set to Y or N to indicate whether FSRCH should
  96.     limit each character in the file to a 7-bit value.  Masking the top
  97.     bit off allows FSRCH to accurately recognize text that has the 
  98.     upper bit forced to be set.
  99.  
  100.  
  101.  
  102. As each search is done, the results are written to the indicated output
  103. file and displayed on the screen.  Optionally, FSRCH will pause after 
  104. each match and wait for you to confirm that it is to proceed.  When the
  105. search is complete, FSRCH will ask if you want to perform additional
  106. searches or terminate.  If you choose to change parameters and search
  107. again, FSRCH displays the parameters used in the last search and allows
  108. you to change any that might require change.  Results of subsequent
  109. searches are appended onto the output file produced by the intial search.
  110.  
  111. The search results file indicates which files were search, what the objects
  112. of the search were, and which lines contained text that matched the search
  113. criteria.  If the file being searched is NOT a simple ASCII text file 
  114. (e.g. a word processor file or an EXE file) the line number assigned to
  115. each match is a fairly arbitrary indication of the relative position in
  116. the file.  If the search file is simple ASCII text file, the line number
  117. is correct.
  118.  
  119.  
  120.  
  121. This is a SHAREWARE product.  It may be freely distributed for trial
  122. use as long as it is not changed in any way.  Shareware developers
  123. do not receive any compensation from shareware distribution companies.
  124. The only compensation that developers receive is from a portion of
  125. the registration fee that users provide when they find the product
  126. useful.  It is important that you register the product if you are
  127. going to use it.  The registration process provides you with a license
  128. to use the product on a single machine.  Site licenses are always
  129. available for companies that need to use multiple copies of the
  130. program.
  131.  
  132.  
  133.  
  134.  
  135.  
  136.     Stan Leeson
  137.     Leeson Software Services
  138.     P.O. Box 130672
  139.     Roseville, MN  55113-0006
  140.  
  141.  
  142.  
  143.  
  144. NOTE TO SHAREWARE DISTRIBUTORS:
  145.     Leeson Software Services will gladly provide recognized shareware
  146.     distributors with personalized copies of the latest shareware version
  147.     of any of our software products.  Typically this would consist a
  148.     modified registration form with the name and address of the shareware
  149.     distributor filled in.  This information allows us to send current
  150.     copies of the software to distributors when there is an update.  In
  151.     addition, we provide a $1.00 rebate to distributors for all but the first
  152.     registration received in a calendar quarter.  So, it pays to have the
  153.     registrations traceable to you.
  154.  
  155.     Individual registered users can receive the same $1.00 rebate.  Just
  156.     request that a personalized Shareware version be sent with your
  157.     registered copy, and then distribute it to others who may be interested.
  158.  
  159.     Rebates will not be provided for the first registration in a calendar
  160.     quarter.  They will also not be provided to unregistered users who are
  161.     not recognized shareware distribution companies.
  162.  
  163.  
  164.  
  165.